Back to Asset Essentials Main Menu

Smart Assets Integration for IoT Work Orders Notification

Overview

This guide explains how to use Smart Assets to receive Work Order (WO) status update notifications in Asset Essentials (AE) as an IoT provider.

Smart Assets is the required integration mechanism for this process and replaces direct real-time API calls to Asset Essentials for retrieving Work Order updates. The integration ensures a reliable, standardised, and scalable way to deliver WO status changes to connected IoT systems.

Note: This feature applies only to Work Orders that were originally created through the Smart Assets IoT integration. It is not for new IoT provider onboarding.

How It Works

When the status of a Work Order changes in Asset Essentials for a WO that was generated by an IoT provider, Smart Assets publishes an event to a provider-specific AWS SQS queue. The IoT provider subscribes to that queue and consumes the WO status update event.

 

This is an extension of the existing IoT alert-to-Work Order flow. The full end-to-end process works as follows:

 

  1. IoT system detects a reading anomaly

    ↓

  2. IoT system sends the anomaly alert to Smart Assets

    ↓

  3. Smart Assets validates tenant and asset mappings

    ↓

  4. Smart Assets creates a Work Order in Asset Essentials

    ↓

  5. Work Order status is updated in Asset Essentials

    ↓

  6. Smart Assets publishes a status update event to the provider-specific SQS queue

    ↓

  7. IoT provider consumes the WO status update event

 

Review this flow in full before proceeding with configuration or API usage.

 

Prerequisites

Before Work Order status update notifications can be delivered, all the following must be completed:

 

  • The Asset Essentials tenant is onboarded in Smart Assets

  • All required asset details are onboarded in Smart Assets

  • Brightly has mapped AE tenant and asset IDs to IoT provider IDs (if provider IDs are used)

  • An API key has been issued by Brightly and stored securely

  • The IoT provider has subscribed to the Smart Assets dedicated SQS queue

     

Important: Do not proceed with integration steps until all prerequisites are met. Missing prerequisites will prevent Work Order notifications from being delivered.

 

Receiving Work Order Status Update Notifications

When the status of a Work Order is updated in Asset Essentials — specifically for Work Orders that were generated by an IoT provider — a notification is dispatched to Smart Assets. Smart Assets then pushes the updated event to the corresponding provider-specific AWS SQS queue, from which the IoT provider can consume the WO status update event.

 

Trigger Condition

Trigger Description
Work Order Status Updated The status of a WO in AE changes for a WO originally created by an IoT provider via Smart Assets

Note: Notifications are sent for status updates only. Other Work Order field changes (such as assignee, priority, or scheduled date) do not trigger a notification.

 

Event Payload

When a WO status update event is published to the SQS queue, it follows this structure:

 
{
"version": "0",
"id": "aad802ed-c891-84cc-fcf5-ef51aa2e498c",
"detail-type": "si.smartassets.workorder-updated",
"source": "com.si.iot",
"account": "349776708714",
"time": "2026-06-01T07:30:34Z",
"region": "us-east-1",
"resources": [],
"detail": {
"tenantInternalId": "ReadingAnomalyTest",
"assetInternalId": "512",
"readingAnomalyId": "2132543",
"actionId": "69434",
"actionUrl": "https://assetessentials.dudesoln.com/TestingIoTMaster/V2WorkOrder/Details?id=69434",
"status": "On Hold",
"statusType": "open",
"providers": ["apiprovider"],
"actionTaken": null,
"actionNumber": "0000019649",
"createdDate": "2026-05-29T09:19:15.433Z",
"completionDate": null,
"timeSpent": 0,
"priority": "Spare Time",
"workRequested": "Temperature Anomaly: Temperature breached 90C for Device 001",
"expected": null,
"assignee": "User Name"
 }
}

Payload Field Reference

Field Description
version Event schema version
id Unique event identifier
detail-type Event type — always si.smartassets.workorder-updated
source Event source — always com.si.iot
time Timestamp of the event (UTC)
region AWS region where the event was published
detail.tenantInternalId Asset Essentials tenant ID
detail.assetInternalId Asset Essentials asset ID
detail.readingAnomalyId The original anomaly ID that triggered WO creation
detail.actionId Asset Essentials Work Order ID
detail.actionUrl Direct URL to the Work Order in Asset Essentials
detail.status Current Work Order status in AE (e.g. On Hold)
detail.status Type Status category (e.g. open)
detail.providers List of IoT provider codes associated with this WO
detail.action Number Asset Essentials Work Order number
detail.created Date Work Order creation date (UTC)
detail.completion Date Work Order completion date — null if not yet completed
detail.time Spent Time spent on the Work Order (in minutes)
detail.priority Work Order priority
detail.work Requested Description of the work — sourced from the original anomaly alert
detail.action Taken Action taken on the WO — null if not yet recorded
detail.expected Expected resolution — null if not set
detail.assignee Name of the user assigned to the Work Order

Configuration Steps

Follow these steps to enable Work Order status notifications for your IoT system:

 

  1. Tenant onboarding: Confirm your Asset Essentials tenant is onboarded in Smart Assets. Contact Brightly if this step has not been completed.

  2. Asset onboarding: Work with Brightly to onboard all assets in Smart Assets that may generate Work Orders. Ensure all assets are onboarded before sending anomaly events.

  3. Asset mapping (if applicable): If your IoT provider uses provider asset IDs, Brightly and the client map them to AE asset IDs. Asset mapping must be completed before alerts for those assets can create Work Orders.

  4. Tenant mapping (if applicable): If your IoT provider uses a provider tenant ID, brightly maps it to the AE tenant ID. Skip this step only if your IoT provider does not use tenant-level identifiers.

  5. Subscribe to the Smart Assets SQS queue: Your IoT provider must subscribe to the dedicated Smart Assets SQS queue to begin receiving WO status update events. Contact Brightly to obtain your provider-specific queue details.

  6. Add new assets later: For any new assets added after go-live, repeat the asset onboarding and mapping steps. New assets must be fully onboarded and mapped before Work Orders for those assets can trigger notifications.

Important Notes

  • Smart Assets is required for receiving WO notifications. Direct real-time API calls to Asset Essentials are not recommended.

  • Notifications are delivered only when all required mappings already exist in Smart Assets. Unmapped assets will not trigger notifications.

  • This integration covers Work Order status updates only. It does not cover other Work Order field changes.

  • Each IoT provider has its own dedicated SQS queue — events are not shared across providers.

  • This is a generic IoT provider integration and is not specific to any single IoT platform.

 

Frequently Asked Questions

Q: Is Smart Assets required for this?

A: Yes. Smart Assets is the required path for receiving Work Order status update notifications. Direct real-time API calls to Asset Essentials are not recommended for this use case.

 

Q: Can our IoT system call Asset Essentials directly instead?

A: No. Direct real-time API calls to Asset Essentials are not recommended. Smart Assets provides the standardised, reliable mechanism for this integration.

 

Q: What happens if asset or tenant mappings are missing?

A: A Work Order notification will not be delivered. Ensure all tenant and asset mappings are completed in Smart Assets before expecting notifications.

 

Q: Do new assets need to be set up separately?

A: Yes. New assets must be onboarded and mapped in Smart Assets before Work Orders for those assets can trigger status update notifications.

 

Q: Will we receive a notification when a Work Order is first created?

A: No. Notifications are sent for Work Order status changes only. The initial Work Order creation does not trigger a notification event.

 

Q: How do we subscribe to the SQS queue?

A: Contact Brightly to obtain your provider-specific SQS queue details and complete the subscription setup.